Add `relatedResource` property to `VerifiablePresentation` #1370

msporny · 2023-12-03T21:03:19Z

This PR attempts to address issue #1360 by allowing the relatedResource property to be used on a VerifiablePresentation. It also adds an "at risk" issue marker noting that the feature might be removed in the Candidate Recommendation phase based on implementer feedback.

Preview | Diff

iherman · 2023-12-04T07:43:06Z

index.html

        </p>
        <p class="issue" title="Mandatory listing of contexts in relatedResouce are under debate.">
 The requirement that contexts be listed in `relatedResource` is currently being
 debated in the VCWG. This requirement might be removed in future iterations of
 the specification.
+        </p>
+        <p class="issue at-risk" title="Use of `relatedResource` in `VerifiablePresentation`">


Suggested change

<p class="issue at-risk" title="Use of `relatedResource` in `VerifiablePresentation`">

<p class="issue at-risk" title="Use of `relatedResource` in `VerifiablePresentation` is at risk">

I think it is better to make the "at risk" features very explicit when reading the document. (I have not checked whether this is the case for the other, at risk features in the spec.)

I got the "atrisk" class wrong and fixed it in de83559.

Which results in this rendering, does that work for you @iherman ?

Looks perfect! 😀

OR13 · 2023-12-04T20:19:00Z

vocab/credentials/v2/vocabulary.yml

@@ -163,7 +163,7 @@ property:

  - id: relatedResource
    label: Related resource
-    domain: cred:VerifiableCredential
+    domain: [cred:VerifiableCredential, cred:VerifiablePresentation]


sry, I meant for this comment to go on "range".

Given this points to credentials by URL, which can't you use a Data URI here?

{ "@context": [ "https://www.w3.org/ns/credentials/v2", "https://www.w3.org/ns/credentials/examples/v2" ], "id": "urn:uuid:5ec137ea-871e-11ee-a783-ef96a4397a9a", "type": ["VerifiablePresentation", "ExamplePresentation"], "relatedResource": [ "https://vendor.example/resources/42", "data:application/jwt;base64,QzVjV...RMjUK==", "data:application/cwt;base64,ZmlOW...pYzMK=" ] }

confusing when comparing to https://github.com/w3c/vc-data-model/pull/1372/files#diff-dfe00db9d510a45f71289312990ee36df870f36c02094551bfba625dcd0d8e96R193

Because an enveloped credential is far more that just a "related resource".

it would be concerning to me to use this property to represent jwts/cwts that are transformable to w3c vcs

@decentralgabe, would you find this mechanism more acceptable? #1379 (preview here)

OR13 · 2023-12-04T20:25:50Z

index.html

 <code>relatedResource</code> is present, there MUST be an object in the array
-for each remote resource for each context used in the verifiable credential.
+for each remote resource used in the verifiable credential.


data URIs are IRIs.

jandrieu · 2023-12-05T23:07:24Z

This is still a layering error

jandrieu

Remove this. It isn't a good adjustment.

iherman · 2023-12-06T08:57:17Z

The issue was discussed in a meeting on 2023-12-05

no resolutions were taken

View the transcript

1.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)

See github pull request vc-data-model#1370.

Brent Zundel: only has approvals.
… likely to get merged within the week.

Joe Andrieu: I still think this is a layering error. I don't know why Verifier would know how to interpret related resource, they didn't ask for it, it's not a VC, I think most use cases could be handled w/ a VC or how to secure contexts for ... generic mechanism seems wrong.

Manu Sporny: I largely agree with Joe on his use cases. We should probably have a context securing mechanism.
… and have something for enveloped VCs.
… a fear is that some implementers are going to use related resources as a dumping ground for all sorts of things.
… I want to express XYZ, I'm going to put that in there.
… All that to say, Joe has a point.
… But if folks want to use the data model in that way, they can.

Joe Andrieu: I want to note that anyone can add to the context and they can add properties. What we're talking about here is that everyone has to respect... we aren't preventing people that want to use relatedResource. I don't see reason for extensibility in this way.

Brent Zundel: I see the benefit of having more specific mechanisms for the different things.
… would the related resource be seen as a stepping stone?

Joe Andrieu: I think a lot of it is lessons learned from extensible HTTP headers, which was "X-something"... if people start using it, they won't stop using it. If burden is you have your own context that does something specific. That's the path towards getting new things into VCDM. I'm afraid of setting the wrong direction here.

Dave Longley: +1 to Joe that once people start using things they won't stop ... there are advantages for putting slight speed bumps in the way to make people do things in better ways.

Brent Zundel: this PR has nothing but approvals.

jandrieu

This should not go in. It's a layer violation.

msporny · 2023-12-07T23:47:55Z

@jandrieu wrote:

This should not go in. It's a layer violation.

You noted on the call that you were a non-blocking objection for this PR.

However, your comment above could be seen as objecting to this PR.

Are you ok with it being merged, or are you objecting to it being merged?

jandrieu · 2023-12-09T20:47:48Z

That was a miscommunication.

I do object to this going in.

msporny · 2023-12-09T21:42:08Z

@jandrieu wrote:

I do object to this going in.

Ok, marking this as pending close, then.

iherman · 2023-12-12T17:12:48Z

The issue was discussed in a meeting on 2023-12-12

no resolutions were taken

View the transcript

2.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)

See github pull request vc-data-model#1370.

Brent Zundel: First up, 1370.
… Looks like Joe is opposed.
… We don't have consensus on this. Looking to close.
… happy to take comments. if folks are opposed, we can timebox a conversation.

Manu Sporny: As a heads up, I curated the PRs and put pending close on any thing that has an objection without a work-around.
… we need to get more aggressive about closing.
… Just an explanation about why things are marked pending closed.
… Another thing to ask is whether or not the objector would make an FO on this change.
… My concern about this PR is that if we don't put Related Resource will not have a way of adding a hash for a JSON LD context in addition to the base context.
… It has been asserted that you don't have to do that if you have static contexts.
… Orie's not here, who might be objecting.

Joe Andrieu: Yes, I am opposed to this, I would Formally Object, I think this is a huge layer violation. It creates an opportunity for surveillance through related resource, I think we can solve context securing in a different way.
… Manu, noted that VC-JOSE-COSE folks want to use JSON-LD Contexts... they should just use JSON-LD.

Ivan Herman: I'm neutral on the original thing. but what was just proposed to Joe seems the wrong thing to do.
… saying that it can only be used for certain purposes sounds bad.
… that requires additional restrictions through new properties.
… I can't object as a W3C staff, but I don't like it.

Manu Sporny: FWIW, I agree with Ivan, I was just trying to find a way through this where we don't end up w/ FOs.

Brent Zundel: I'm seeing no consensus here.
… We don't have Orie, so we can't ask him.
… based on the information we have, we should close this PR.
… I'd like to close it now, but we just put the pending close label on this three days ago.

Manu Sporny: note, if Orie is going to formally object (because you can't secure context).
… our way through this would be to have a "relatedContext" property.
… I think Joe would not be opposed to that. And maybe Orie would find that ok.

Ivan Herman: I want to remind people that there was a feature freeze a while ago.
… what you just proposed feels like a new feature. It's just too late.
… We can't work that way or we'll never finish.

Brent Zundel: appreciate the reminders.

msporny · 2023-12-15T17:12:08Z

PR failed to achieve consensus, marked "pending close" for over a week, closing.

msporny added 4 commits December 3, 2023 15:47

Allow relatedResource to be used in presentations.

ce9cf15

Update domain for relatedResource.

acc5b0a

Add relatedResource to VerifiablePresentation in JSON-LD Context.

1eb2962

Add at risk issue marker for relatedResource.

bc4edbf

msporny requested review from dlongley, jandrieu, longpd, iherman, dmitrizagidulin, mprorock, David-Chadwick, brianorwhatever, decentralgabe, OR13 and brentzundel December 3, 2023 21:03

msporny requested a review from selfissued as a code owner December 3, 2023 21:03

msporny mentioned this pull request Dec 3, 2023

Add mechanism to cryptographically secure non-credential VP properties (contexts etc) #1360

Open

msporny added the before-CR label Dec 3, 2023

iherman approved these changes Dec 4, 2023

View reviewed changes

Fix usage of "atrisk" CSS class.

de83559

longpd approved these changes Dec 4, 2023

View reviewed changes

iherman mentioned this pull request Dec 4, 2023

Add the EnvelopedVerifiableCredential class to the vocabulary #1372

Closed

andresuribe87 approved these changes Dec 4, 2023

View reviewed changes

brentzundel changed the title ~~Add relatedResource property to VerifiableCredential~~ Add relatedResource property to VerifiablePresentation Dec 4, 2023

brentzundel approved these changes Dec 4, 2023

View reviewed changes

dlongley approved these changes Dec 4, 2023

View reviewed changes

OR13 reviewed Dec 4, 2023

View reviewed changes

jandrieu requested changes Dec 5, 2023

View reviewed changes

jandrieu requested changes Dec 6, 2023

View reviewed changes

msporny added the pending close Close if no objection within 7 days label Dec 9, 2023

msporny closed this Dec 15, 2023

msporny deleted the msporny-vp-relatedResource branch December 17, 2023 19:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `relatedResource` property to `VerifiablePresentation` #1370

Add `relatedResource` property to `VerifiablePresentation` #1370

msporny commented Dec 3, 2023 •

edited by pr-preview bot

Loading

iherman Dec 4, 2023

msporny Dec 4, 2023

iherman Dec 4, 2023

OR13 Dec 4, 2023 •

edited

Loading

OR13 Dec 4, 2023

BigBlueHat Dec 5, 2023

decentralgabe Dec 11, 2023

msporny Dec 11, 2023 •

edited

Loading

OR13 Dec 4, 2023

jandrieu commented Dec 5, 2023

jandrieu left a comment

iherman commented Dec 6, 2023

1.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)

jandrieu left a comment

msporny commented Dec 7, 2023

jandrieu commented Dec 9, 2023

msporny commented Dec 9, 2023

iherman commented Dec 12, 2023

2.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)

msporny commented Dec 15, 2023

	<p class="issue at-risk" title="Use of `relatedResource` in `VerifiablePresentation`">
	<p class="issue at-risk" title="Use of `relatedResource` in `VerifiablePresentation` is at risk">

Add relatedResource property to VerifiablePresentation #1370

Add relatedResource property to VerifiablePresentation #1370

Conversation

msporny commented Dec 3, 2023 • edited by pr-preview bot Loading

iherman Dec 4, 2023

Choose a reason for hiding this comment

msporny Dec 4, 2023

Choose a reason for hiding this comment

iherman Dec 4, 2023

Choose a reason for hiding this comment

OR13 Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

OR13 Dec 4, 2023

Choose a reason for hiding this comment

BigBlueHat Dec 5, 2023

Choose a reason for hiding this comment

decentralgabe Dec 11, 2023

Choose a reason for hiding this comment

msporny Dec 11, 2023 • edited Loading

Choose a reason for hiding this comment

OR13 Dec 4, 2023

Choose a reason for hiding this comment

jandrieu commented Dec 5, 2023

jandrieu left a comment

Choose a reason for hiding this comment

iherman commented Dec 6, 2023

1.1. Add relatedResource property to VerifiablePresentation (pr vc-data-model#1370)

jandrieu left a comment

Choose a reason for hiding this comment

msporny commented Dec 7, 2023

jandrieu commented Dec 9, 2023

msporny commented Dec 9, 2023

iherman commented Dec 12, 2023

2.1. Add relatedResource property to VerifiablePresentation (pr vc-data-model#1370)

msporny commented Dec 15, 2023

Add `relatedResource` property to `VerifiablePresentation` #1370

Add `relatedResource` property to `VerifiablePresentation` #1370

msporny commented Dec 3, 2023 •

edited by pr-preview bot

Loading

OR13 Dec 4, 2023 •

edited

Loading

msporny Dec 11, 2023 •

edited

Loading

1.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)

2.1. Add `relatedResource` property to `VerifiablePresentation` (pr vc-data-model#1370)